# Q. What is this file?
# A. This file contains options which allow you to configure your multiworld experience while allowing
#    others to play how they want as well.
#
# Q. How do I use it?
# A. The options in this file are weighted. This means the higher number you assign to a value, the
#    more chances you have for that option to be chosen. For example, an option like this:
#
#    map_shuffle:
#      on: 5
#      off: 15
#
#    Means you have 5 chances for map shuffle to occur, and 15 chances for map shuffle to be turned
#    off.
#
# Q. I've never seen a file like this before. What characters am I allowed to use?
# A. This is a .yaml file. You are allowed to use most characters.
#    To test if your yaml is valid or not, you can use this website:
#        http://www.yamllint.com/
#    You can also verify that your Archipelago options are valid at this site:
#        https://archipelago.gg/check

# Your name in-game, limited to 16 characters.
#     {player} will be replaced with the player's slot number.
#     {PLAYER} will be replaced with the player's slot number, if that slot number is greater than 1.
#     {number} will be replaced with the counter value of the name.
#     {NUMBER} will be replaced with the counter value of the name, if the counter value is greater than 1.
name: Player{number}

# Used to describe your yaml. Useful if you have multiple files.
description: Default Battle for Bikini Bottom Template

game: Battle for Bikini Bottom
requires:
  version: 0.6.6 # Version of Archipelago required for this yaml to work as expected.
  game:
    Battle for Bikini Bottom: 1.2.4 # Version of the world required for this yaml to work as expected.

Battle for Bikini Bottom:
  ################
  # Game Options #
  ################
  progression_balancing:
    # A system that can move progression earlier, to try and prevent the player from getting stuck and bored early.
    # 
    # A lower setting means more getting stuck. A higher setting means less getting stuck.
    #
    # You can define additional values between the minimum and maximum values.
    # Minimum value is 0
    # Maximum value is 99
    random: 0
    random-low: 0 # random value weighted towards lower values
    random-high: 0 # random value weighted towards higher values
    random-range-0-99: 0 # random value between 0 and 99
    disabled: 0 # equivalent to 0
    normal: 50 # equivalent to 50
    extreme: 0 # equivalent to 99

  accessibility:
    # Set rules for reachability of your items/locations.
    # 
    # **Full:** ensure everything can be reached and acquired.
    # 
    # **Minimal:** ensure what is needed to reach your goal can be acquired.
    full: 50
    minimal: 0

  available_spatulas:
    # Amount of available golden spatulas
    #
    # You can define additional values between the minimum and maximum values.
    # Minimum value is 75
    # Maximum value is 100
    100: 50
    random: 0
    random-low: 0 # random value weighted towards lower values
    random-high: 0 # random value weighted towards higher values
    random-range-75-100: 0 # random value between 75 and 100

  required_spatulas:
    # Amount of golden spatulas required to enter the last boss fight
    #
    # You can define additional values between the minimum and maximum values.
    # Minimum value is 20
    # Maximum value is 99
    75: 50
    random: 0
    random-low: 0 # random value weighted towards lower values
    random-high: 0 # random value weighted towards higher values
    random-range-20-99: 0 # random value between 20 and 99

  include_socks:
    # Include Socks as AP Locations/Items
    'false': 0
    'true': 50

  include_skills:
    # Include Skills (Bubble Bowl & Cruise Bubble) as AP Locations/Items
    'false': 0
    'true': 50

  include_golden_underwear:
    # Include Golden Underwear as AP Locations/Items
    'false': 0
    'true': 50

  include_level_items:
    # Include Level Pickups (steering wheels, balloon kids etc.) as AP Locations/Items
    'false': 0
    'true': 50

  include_purple_so:
    # Include Purple Shiny Objects as AP Locations/Items
    'false': 0
    'true': 50

  randomize_gate_cost:
    # Randomize how many golden spatulas are required for taxi gates.
    # This will pick a random level order and increment on gate cost according to the level order.
    # Low, mid and high refer to possible increment between levels.
    # High will likely fail to generate on single player seeds or seeds with few filler locations.
    # All gate cost will be below the required spatula count.
    'off': 50
    low: 0
    mid: 0
    high: 0

  death_link:
    # When you die, everyone who enabled death link dies. Of course, the reverse is true too.
    'false': 50
    'true': 0

  ring_link:
    # Enables Ring Link support for Shiny Objects
    'false': 50
    'true': 0

  shiny_object_to_ring_ratio:
    # How many Shiny Objects should amount to one Ring in Ring Link
    #
    # You can define additional values between the minimum and maximum values.
    # Minimum value is 1
    # Maximum value is 100
    10: 50
    random: 0
    random-low: 0 # random value weighted towards lower values
    random-high: 0 # random value weighted towards higher values
    random-range-1-100: 0 # random value between 1 and 100

  ###########################
  # Item & Location Options #
  ###########################
  local_items:
    # Forces these items to be in their native world.
    []

  non_local_items:
    # Forces these items to be outside their native world.
    []

  start_inventory:
    # Start with the specified amount of these items. Example: "Bomb: 1"
    {}

  start_inventory_from_pool:
    # Start with the specified amount of these items and don't place them in the world. Example: "Bomb: 1"
    # 
    # The game decides what the replacement items will be.
    {}

  start_hints:
    # Start with these item's locations prefilled into the ``!hint`` command.
    []

  start_location_hints:
    # Start with these locations and their item prefilled into the ``!hint`` command.
    []

  exclude_locations:
    # Prevent these locations from having an important item.
    []

  priority_locations:
    # Prevent these locations from having an unimportant item.
    []

  item_links:
    # Share part of your item pool with other players.
    []

  plando_items:
    # Generic items plando.
    []
